com.inscoper.nbo.PlateAcquisition

Represents the XML element PlateAcquisition. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	PlateAcquisition()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(PlateAcquisitionID_Type value) Sets the value of the ID attribute.
PlateAcquisitionID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(String value) Sets the value of the Name attribute.
String	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setEndTime(String value) Sets the value of the EndTime attribute.
String	getEndTime() Returns the value of the EndTime attribute.
void	resetEndTime() Resets the EndTime attribute to an unset state.
boolean	hasEndTime() Checks whether the optional EndTime attribute is present.
void	setStartTime(String value) Sets the value of the StartTime attribute.
String	getStartTime() Returns the value of the StartTime attribute.
void	resetStartTime() Resets the StartTime attribute to an unset state.
boolean	hasStartTime() Checks whether the optional StartTime attribute is present.
void	setMaximumFieldCount(PositiveInt_Type value) Sets the value of the MaximumFieldCount attribute.
PositiveInt_Type	getMaximumFieldCount() Returns the value of the MaximumFieldCount attribute.
void	resetMaximumFieldCount() Resets the MaximumFieldCount attribute to an unset state.
boolean	hasMaximumFieldCount() Checks whether the optional MaximumFieldCount attribute is present.
void	setDescription(PlateAcquisition_InlineDescription value) Sets the value of the Description element.
PlateAcquisition_InlineDescription	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setWellSampleRef_List(WellSampleRefVector value) Sets the list of WellSampleRef elements.
WellSampleRefVector	getWellSampleRef_List() Returns the list of WellSampleRef elements.
void	addToWellSampleRef_List(WellSampleRef value) Adds a new WellSampleRef element to this object.
void	clearWellSampleRef_List() Clear the list of WellSampleRef.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
PlateAcquisition	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	PlateAcquisition(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(PlateAcquisition obj)

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.PlateAcquisition;

Represents the XML element PlateAcquisition.

PlateAcquisition is used to describe a single Acquisition run for a plate. This object is used to record the set of images acquired in a single Acquisition run. The Images for this run are linked to PlateAcquisition through WellSample.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function PlateAcquisition

public PlateAcquisition()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    PlateAcquisitionID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getID

public PlateAcquisitionID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setName

public void setName(
    String value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getName

public String getName()

Returns the value of the Name attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

No description available in the XSD standard.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setEndTime

public void setEndTime(
    String value
)

Sets the value of the EndTime attribute.

Parameters:

value The value to set

Time when the last Image of this Acquisition was collected

function getEndTime

public String getEndTime()

Returns the value of the EndTime attribute.

Return: The value of the attribute

Time when the last Image of this Acquisition was collected

function resetEndTime

public void resetEndTime()

Resets the EndTime attribute to an unset state.

Time when the last Image of this Acquisition was collected

function hasEndTime

public boolean hasEndTime()

Checks whether the optional EndTime attribute is present.

Return: true if the optional attribute has been set, false otherwise

Time when the last Image of this Acquisition was collected

function setStartTime

public void setStartTime(
    String value
)

Sets the value of the StartTime attribute.

Parameters:

value The value to set

Time when the first Image of this Acquisition was collected

function getStartTime

public String getStartTime()

Returns the value of the StartTime attribute.

Return: The value of the attribute

Time when the first Image of this Acquisition was collected

function resetStartTime

public void resetStartTime()

Resets the StartTime attribute to an unset state.

Time when the first Image of this Acquisition was collected

function hasStartTime

public boolean hasStartTime()

Checks whether the optional StartTime attribute is present.

Return: true if the optional attribute has been set, false otherwise

Time when the first Image of this Acquisition was collected

function setMaximumFieldCount

public void setMaximumFieldCount(
    PositiveInt_Type value
)

Sets the value of the MaximumFieldCount attribute.

Parameters:

value The value to set

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

function getMaximumFieldCount

public PositiveInt_Type getMaximumFieldCount()

Returns the value of the MaximumFieldCount attribute.

Return: The value of the attribute

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

function resetMaximumFieldCount

public void resetMaximumFieldCount()

Resets the MaximumFieldCount attribute to an unset state.

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

function hasMaximumFieldCount

public boolean hasMaximumFieldCount()

Checks whether the optional MaximumFieldCount attribute is present.

Return: true if the optional attribute has been set, false otherwise

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

function setDescription

public void setDescription(
    PlateAcquisition_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

A description for the PlateAcquisition.

function getDescription

public PlateAcquisition_InlineDescription getDescription()

Returns the value of the Description element.

Return: The value of the element

A description for the PlateAcquisition.

function resetDescription

public void resetDescription()

Resets the Description element to an unset state.

A description for the PlateAcquisition.

function hasDescription

public boolean hasDescription()

Checks whether the optional Description element is present.

Return: true if the optional attribute has been set, false otherwise

A description for the PlateAcquisition.

function setWellSampleRef_List

public void setWellSampleRef_List(
    WellSampleRefVector value
)

Sets the list of WellSampleRef elements.

Parameters:

value The new list of WellSampleRef elements

No description available in the XSD standard.

function getWellSampleRef_List

public WellSampleRefVector getWellSampleRef_List()

Returns the list of WellSampleRef elements.

Return: The list of WellSampleRef elements

No description available in the XSD standard.

function addToWellSampleRef_List

public void addToWellSampleRef_List(
    WellSampleRef value
)

Adds a new WellSampleRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearWellSampleRef_List

public void clearWellSampleRef_List()

Clear the list of WellSampleRef.

No description available in the XSD standard.

function setAnnotationRef_List

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

No description available in the XSD standard.

function getAnnotationRef_List

public AnnotationRefVector getAnnotationRef_List()

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAnnotationRef_List

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

function __internal_create

public static PlateAcquisition __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function PlateAcquisition

protected PlateAcquisition(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    PlateAcquisition obj
)

Updated on 2026-02-13 at 16:11:05 +0100